useGetExchangeRate

Hook to fetch current exchange rates from USD to other currencies

Import

import { useGetExchangeRate } from '@0xsequence/hooks'

Usage

import { useGetExchangeRate } from '@0xsequence/hooks'

function CurrencyConverter() {
  const usdAmount = 100
  const { 
    data: rate = 1, 
    isLoading, 
    error,
    isError,
    isSuccess 
  } = useGetExchangeRate('EUR')
  
  if (isLoading) {
    return <div>Loading rates...</div>
  }
  
  if (isError) {
    return <div>Error: {error.message}</div>
  }
  
  return (
    <div>
      <h2>Currency Conversion</h2>
      {isSuccess && (
        <div>
          <p>{usdAmount} USD = {usdAmount * rate} EUR</p>
          <p>Current Rate: 1 USD = {rate} EUR</p>
        </div>
      )}
    </div>
  )
}

// Example with multiple currencies
function MultiCurrencyDisplay() {
  const currencies = ['EUR', 'GBP', 'JPY']
  
  return (
    <div>
      <h2>USD Exchange Rates</h2>
      {currencies.map(currency => (
        <CurrencyRate 
          key={currency} 
          currency={currency} 
        />
      ))}
    </div>
  )
}

function CurrencyRate({ currency }) {
  const { data: rate = 1 } = useGetExchangeRate(currency)
  
  return (
    <div>
      1 USD = {rate} {currency}
    </div>
  )
}

Parameters

toCurrency

string

The target currency code (e.g., ‘EUR’, ‘GBP’, ‘JPY’). If ‘USD’ is provided, returns 1 as the conversion rate.

options

HooksOptions (optional)

interface HooksOptions {
  retry?: boolean  // Whether to retry failed requests (defaults to true)
  disabled?: boolean // Whether to disable the query
}

Return Type

The hook returns a React Query result object:

{
  data: number          // The exchange rate value from USD to target currency
  isLoading: boolean    // Whether the initial request is in progress
  error: Error | null   // Any error that occurred
  isError: boolean      // Whether an error occurred
  isSuccess: boolean    // Whether the request was successful
}